Azure AgFoodPlatform Data Plane Service (preview:2021-03-31)

2025/09/26 • 106 new methods

ApplicationData_ListByFarmerId (new)
Description :  Get a paginated list of application data resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/application-data
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
minAvgMaterial:
{
Description: Application data with average material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Application data with average material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Application data with total material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Application data with total material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Application data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Application operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Application operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Application operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Application operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Application operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Application operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Application operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Application operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of application operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of application operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Application data with only given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned. ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned. ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ApplicationData_List (new)
Description :  Get a paginated list of application data resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /application-data
{
minAvgMaterial:
{
Description: Application data with average material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Application data with average material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Application data with total material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Application data with total material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Application data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Application operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Application operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Application operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Application operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Application operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Application operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Application operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Application operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of application operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of application operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Application data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ApplicationData_Get (new)
Description :  Get a specified application data resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/application-data/{applicationDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: Id of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ApplicationData_CreateOrUpdate (new)
Description :  Create or update an application data resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/application-data/{applicationDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: Id of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
applicationData:
{
Description: Application data resource payload to Create or update. ,
Required: False ,
}
{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
applicationProductDetails:
{
Description: Application product details. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a product applied. ,
Required: False ,
}
string ,
isCarrier:
{
Description: Indicates if the product is a carrier for a tank mix. ,
Required: False ,
}
boolean ,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the application data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the application operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the application operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (application). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the application operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the application operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
ApplicationData_Delete (new)
Description :  Delete a specified application data resource for a given farmer.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/application-data/{applicationDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: Id of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ApplicationData_GetCascadeDeleteJobDetails (new)
Description :  Get details of a cascade delete job for application data resource.
Reference :  Link ¶

⚼ Request

GET:  /application-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the application data cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ApplicationData_CreateCascadeDeleteJob (new)
Description :  Create cascade delete job for application data resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /application-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the application data cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
applicationDataId:
{
Description: Id of the application data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Attachments_ListByFarmerId (new)
Description :  Get a paginated list of attachment resources for a given farmer and search criteria.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/attachments
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
resourceIds:
{
Description: Attachments belonging to the given list of resources will be returned. ,
Required: False ,
}
array ,
resourceTypes:
{
Description: Attachments belonging to the resources of the given resource types will be returned. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
array ,
ids:
{
Description: Ids of the attachments to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of attachments to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Attachments with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Attachments created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Attachments created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Attachments last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Attachments last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
resourceId:
{
Description: This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. ,
Required: False ,
}
string ,
resourceType:
{
Description: Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original file name of the attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the attachment. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the attachment. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the attachment. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Attachments_Get (new)
Description :  Get a specified attachment resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/attachments/{attachmentId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
resourceId:
{
Description: This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. ,
Required: False ,
}
string ,
resourceType:
{
Description: Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original file name of the attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the attachment. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the attachment. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the attachment. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Attachments_CreateOrUpdate (new)
Description :  Create or update an attachment resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/attachments/{attachmentId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment. This Id is unique for a given farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
file:
{
Description: File to be uploaded. ,
Format: binary ,
Required: False ,
}
file ,
FarmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
ResourceId:
{
Description: This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. ,
Required: False ,
}
string ,
ResourceType:
{
Description: Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
string ,
OriginalFileName:
{
Description: Original file name of the attachment. ,
Required: False ,
}
string ,
Id:
{
Description: Unique Id of the attachment. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
Status:
{
Description: User provided status of the attachment. ,
Required: False ,
}
string ,
CreatedDateTime:
{
Description: UTC Date-time at which the attachment was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
ModifiedDateTime:
{
Description: UTC Date-time at which the attachment was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
Name:
{
Description: Name of the attachment. ,
Required: False ,
}
string ,
Description:
{
Description: Brief description of the attachment. ,
Required: False ,
}
string ,
ETag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
resourceId:
{
Description: This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. ,
Required: False ,
}
string ,
resourceType:
{
Description: Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original file name of the attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the attachment. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the attachment. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the attachment. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
resourceId:
{
Description: This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. ,
Required: False ,
}
string ,
resourceType:
{
Description: Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. ,
Required: False ,
}
string ,
originalFileName:
{
Description: Original file name of the attachment. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the attachment. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the attachment. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the attachment. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Attachments_Delete (new)
Description :  Delete a specified attachment resource for a given farmer.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/attachments/{attachmentId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of the attachment. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Attachments_Download (new)
Description :  Return attachment as a file stream for a given input filePath.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/attachments/{attachmentId}/file
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
attachmentId:
{
Description: Id of attachment to be downloaded. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_ListByFarmerId (new)
Description :  Get a paginated list of boundary resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/boundaries
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
isPrimary:
{
Description: If set, only primary boundaries are returned. ,
Required: False ,
}
boolean ,
parentType:
{
Description: Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
parentIds:
{
Description: Boundaries associated with the given parent Ids are returned. ,
Required: False ,
}
array ,
minAcreage:
{
Description: Boundaries with acreage equal to or greater than the given value are returned. ,
Format: double ,
Required: False ,
}
number ,
maxAcreage:
{
Description: Boundaries with acreage equal to or lesser than the given value are returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of boundaries to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of boundaries to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Boundaries with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_SearchByFarmerId (new)
Description :  Search for boundaries of a farmer intersecting with a given geometry. This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

POST:  /farmers/{farmerId}/boundaries
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
query:
{
Description: Query filters. ,
Required: False ,
}
{
ids:
{
Description: List of boundary Ids to be searched. ,
Required: False ,
}
[
string ,
]
,
names:
{
Description: List of names of boundaries to be searched. ,
Required: False ,
}
[
string ,
]
,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
[
string ,
]
,
statuses:
{
Description: List of statuses of boundaries to be searched. ,
Required: False ,
}
[
string ,
]
,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
isPrimary:
{
Description: If set, search result will contain only primary boundaries. ,
Required: False ,
}
boolean ,
parentType:
{
Description: Used to search based on the parent type (Field/ SeasonalField). ,
Required: False ,
}
string ,
parentIds:
{
Description: List of parent Ids whose boundaries are to be retrieved. ,
Required: False ,
}
[
string ,
]
,
minAcreage:
{
Description: Minimum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
maxAcreage:
{
Description: Maximum acreage of the boundary (inclusive). ,
Format: double ,
Required: False ,
}
number ,
intersectsWithGeometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_List (new)
Description :  Get a paginated list of boundary resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /boundaries
{
isPrimary:
{
Description: If set, only primary boundaries are returned. ,
Required: False ,
}
boolean ,
parentType:
{
Description: Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
parentIds:
{
Description: Boundaries associated with the given parent Ids are returned. ,
Required: False ,
}
array ,
minAcreage:
{
Description: Boundaries with acreage equal to or greater than the given value are returned. ,
Format: double ,
Required: False ,
}
number ,
maxAcreage:
{
Description: Boundaries with acreage equal to or lesser than the given value are returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of boundaries to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of boundaries to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Boundaries with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_GetCascadeDeleteJobDetails (new)
Description :  Get details of cascade delete job for a specified boundary.
Reference :  Link ¶

⚼ Request

GET:  /boundaries/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the boundary cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_CreateCascadeDeleteJob (new)
Description :  Create a cascade delete job for a specified boundary. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /boundaries/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the boundary cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_Get (new)
Description :  Get a specified boundary resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/boundaries/{boundaryId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_CreateOrUpdate (new)
Description :  Create or update a boundary resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/boundaries/{boundaryId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
boundary:
{
Description: Boundary resource payload to Create or update. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
parentId:
{
Description: If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. ,
Required: False ,
}
string ,
geometry:
{
Description: GeoJSON abstract class. ,
Required: False ,
}
{
type:
{
Description: GeoJSON object type. ,
Enum:
{
Point: No description available. ,
Polygon: No description available. ,
MultiPolygon: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isPrimary:
{
Description: Indicates if the boundary is a primary boundary for the associated parent (if any). ,
Required: False ,
}
boolean ,
acreage:
{
Description: Area of the boundary in acres. ,
Format: double ,
Required: False ,
}
number ,
parentType:
{
Description: Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the boundary. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the boundary. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the boundary. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_Delete (new)
Description :  Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/boundaries/{boundaryId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the boundary to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Boundaries_GetOverlap (new)
Description :  Get overlapping (intersecting) acreage between two boundaries.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/boundaries/{boundaryId}/overlap
{
farmerId:
{
Description: Id of the farmer associated with the given boundary. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the given boundary. ,
Required: True ,
}
string ,
otherFarmerId:
{
Description: Id of the farmer associated with the other boundary. ,
Required: True ,
}
string ,
otherBoundaryId:
{
Description: Id of the other boundary. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boundaryAcreage:
{
Description: Acreage of the main boundary. ,
Format: double ,
Required: False ,
}
number ,
otherBoundaryAcreage:
{
Description: Acreage of the other boundary. ,
Format: double ,
Required: False ,
}
number ,
intersectingAcreage:
{
Description: Acreage of the intersecting area between the given boundaries. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Crops_List (new)
Description :  Get a paginated list of crop resources. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /crops
{
phenotypes:
{
Description: Crops with the given list of phenotypes are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of crops to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of crops to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Crops with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
phenotype:
{
Description: Phenotype of the crop. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Crops_Get (new)
Description :  Get a specified crop resource.
Reference :  Link ¶

⚼ Request

GET:  /crops/{cropId}
{
cropId:
{
Description: Id of the crop. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
phenotype:
{
Description: Phenotype of the crop. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Crops_CreateOrUpdate (new)
Description :  Create or update a crop resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /crops/{cropId}
{
cropId:
{
Description: Id of the crop resource. This Id is unique for a given tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
crop:
{
Description: Crop resource payload to create or update. ,
Required: False ,
}
{
phenotype:
{
Description: Phenotype of the crop. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
phenotype:
{
Description: Phenotype of the crop. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
phenotype:
{
Description: Phenotype of the crop. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Crops_Delete (new)
Description :  Delete a specified crop resource.
Reference :  Link ¶

⚼ Request

DELETE:  /crops/{cropId}
{
cropId:
{
Description: Id of crop to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
CropVarieties_ListByCropId (new)
Description :  Get a paginated list of crop variety resources for a given crop and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /crops/{cropId}/crop-varieties
{
cropId:
{
Description: Id of the associated crop. ,
Required: True ,
}
string ,
cropIds:
{
Description: Crop varieties associated with the given list of crop ids are returned. ,
Required: False ,
}
array ,
brands:
{
Description: Crop varieties associated with the given list of brands are returned. ,
Required: False ,
}
array ,
products:
{
Description: Crop varieties associated with the given list of products are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of crop varieties to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of crop varieties to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Crop varieties with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
CropVarieties_List (new)
Description :  Get a paginated list of crop variety resources across all the crops for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /crop-varieties
{
cropIds:
{
Description: Crop varieties associated with the given list of crop ids are returned. ,
Required: False ,
}
array ,
brands:
{
Description: Crop varieties associated with the given list of brands are returned. ,
Required: False ,
}
array ,
products:
{
Description: Crop varieties associated with the given list of products are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of crop varieties to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of crop varieties to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Crop varieties with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
CropVarieties_Get (new)
Description :  Get a specified crop variety resource for a given crop.
Reference :  Link ¶

⚼ Request

GET:  /crops/{cropId}/crop-varieties/{cropVarietyId}
{
cropId:
{
Description: Id of the associated crop. ,
Required: True ,
}
string ,
cropVarietyId:
{
Description: Id of the crop variety. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
CropVarieties_CreateOrUpdate (new)
Description :  Create or update a crop variety resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /crops/{cropId}/crop-varieties/{cropVarietyId}
{
cropId:
{
Description: Id of the associated crop. ,
Required: True ,
}
string ,
cropVarietyId:
{
Description: Unique Id of the crop variety. This Is is unique for a given crop. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
cropVariety:
{
Description: Crop variety resource payload to create or update. ,
Required: False ,
}
{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
cropId:
{
Description: Id of the associated crop. ,
Required: False ,
}
string ,
brand:
{
Description: Brand of the crop variety. ,
Required: False ,
}
string ,
product:
{
Description: Commercial name of the crop variety. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the crop variety. This Id is unique for a given crop. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the crop variety. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the crop variety. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
CropVarieties_Delete (new)
Description :  Delete a specified crop variety resource for a given crop.
Reference :  Link ¶

⚼ Request

DELETE:  /crops/{cropId}/crop-varieties/{cropVarietyId}
{
cropId:
{
Description: Id of the associated crop. ,
Required: True ,
}
string ,
cropVarietyId:
{
Description: Id of the crop variety to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_List (new)
Description :  Get a paginated list of farmer resources for a given search criteria.
Reference :  Link ¶

⚼ Request

GET:  /farmers
{
ids:
{
Description: List of Ids of farmers to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of farmers to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Farmers with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
id:
{
Description: Unique Id of the farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farmer. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farmer. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_Get (new)
Description :  Get a specified farmer resource.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}
{
farmerId:
{
Description: ID of the farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique Id of the farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farmer. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farmer. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_CreateOrUpdate (new)
Description :  Create or update a farmer resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}
{
farmerId:
{
Description: Id of the farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
farmer:
{
Description: Farmer resource payload to create or update. ,
Required: False ,
}
{
id:
{
Description: Unique Id of the farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farmer. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farmer. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique Id of the farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farmer. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farmer. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique Id of the farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farmer. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farmer. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_Delete (new)
Description :  Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}
{
farmerId:
{
Description: Id of farmer to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_GetCascadeDeleteJobDetails (new)
Description :  Get details of a cascade delete job for a specified farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the farmer cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farmers_CreateCascadeDeleteJob (new)
Description :  Create a cascade delete job for a specified farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /farmers/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the farmer cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the farmer to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
FarmOperations_CreateDataIngestionJob (new)
Description :  Create a farm operation data ingestion job. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PUT:  /farm-operations/ingest-data/{jobId}
{
jobId:
{
Description: Id of the farm operation data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by the user. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the farmer whose farm operations are to be fetched. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere. ,
Required: True ,
}
string ,
operations:
{
Description: List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year). ,
Format: int32 ,
Required: True ,
}
integer ,
id:
{
Description: Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm operations data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm operations data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
farmerId:
{
Description: Id of the farmer whose farm operations are to be fetched. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere. ,
Required: True ,
}
string ,
operations:
{
Description: List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year). ,
Format: int32 ,
Required: True ,
}
integer ,
id:
{
Description: Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm operations data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm operations data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
FarmOperations_GetDataIngestionJobDetails (new)
Description :  Get details of a farm operation data ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /farm-operations/ingest-data/{jobId}
{
jobId:
{
Description: Id of the farm operation data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the farmer whose farm operations are to be fetched. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere. ,
Required: True ,
}
string ,
operations:
{
Description: List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage. ,
Required: False ,
}
[
string ,
]
,
startYear:
{
Description: The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year). ,
Format: int32 ,
Required: True ,
}
integer ,
id:
{
Description: Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm operations data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm operations data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_ListByFarmerId (new)
Description :  Get a paginated list of farm resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/farms
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
ids:
{
Description: List of Ids of farms to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of farms to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Farms with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_List (new)
Description :  Get a paginated list of farm resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farms
{
ids:
{
Description: List of Ids of farms to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of farms to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Farms with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_Get (new)
Description :  Get a specified farm resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/farms/{farmId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
farmId:
{
Description: ID of the farm. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_CreateOrUpdate (new)
Description :  Create or update a farm resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/farms/{farmId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
farmId:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
farm:
{
Description: Farm resource payload to create or update. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the farm. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the farm. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the farm. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_Delete (new)
Description :  Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/farms/{farmId}
{
farmerId:
{
Description: Id of the farmer. ,
Required: True ,
}
string ,
farmId:
{
Description: Id of the farm to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_GetCascadeDeleteJobDetails (new)
Description :  Get details of cascade delete job for a specified farm.
Reference :  Link ¶

⚼ Request

GET:  /farms/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the farm cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Farms_CreateCascadeDeleteJob (new)
Description :  Create a cascade delete job for a specified farm. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /farms/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the farm cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: ID of the associated farmer. ,
Required: True ,
}
string ,
farmId:
{
Description: ID of the farm to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_ListByFarmerId (new)
Description :  Get a paginated list of field resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/fields
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
farmIds:
{
Description: Fields associated with the given list of farms are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of fields to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of fields to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Fields with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_List (new)
Description :  Get a paginated list of field resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /fields
{
farmIds:
{
Description: Fields associated with the given list of farms are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of fields to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of fields to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Fields with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_Get (new)
Description :  Get a specified field resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/fields/{fieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
fieldId:
{
Description: Id of the field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_CreateOrUpdate (new)
Description :  Create or update a field resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/fields/{fieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
fieldId:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
field:
{
Description: Field resource payload to Create or update. ,
Required: False ,
}
{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the field. ,
Required: False ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_Delete (new)
Description :  Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/fields/{fieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
fieldId:
{
Description: Id of the field to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_GetCascadeDeleteJobDetails (new)
Description :  Get details of cascade delete job for a specified field.
Reference :  Link ¶

⚼ Request

GET:  /fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of field cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Fields_CreateCascadeDeleteJob (new)
Description :  Create a cascade delete job for specified field. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of field cascade delete job. This Id is unique for a given tenant. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
fieldId:
{
Description: ID of the field to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_ListByFarmerId (new)
Description :  Get a paginated list of harvest data resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/harvest-data
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
minTotalYield:
{
Description: Harvest data with total yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalYield:
{
Description: Harvest data with total yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgYield:
{
Description: Harvest data with average yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgYield:
{
Description: Harvest data with average yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalWetMass:
{
Description: Harvest data with total wet mass greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalWetMass:
{
Description: Harvest data with total wet mass lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgWetMass:
{
Description: Harvest data with average wet mass greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgWetMass:
{
Description: Harvest data with average wet mass lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgMoisture:
{
Description: Harvest data with average moisture greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMoisture:
{
Description: Harvest data with average moisture lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgSpeed:
{
Description: Harvest data with average speed greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgSpeed:
{
Description: Harvest data with average speed lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Harvest data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Harvest operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Harvest operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Harvest operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Harvest operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Harvest operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Harvest operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Harvest operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Harvest operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of harvest operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of harvest operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Harvest data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_List (new)
Description :  Get a paginated list of harvest data resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /harvest-data
{
minTotalYield:
{
Description: Harvest data with total yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalYield:
{
Description: Harvest data with total yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgYield:
{
Description: Harvest data with average yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgYield:
{
Description: Harvest data with average yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalWetMass:
{
Description: Harvest data with total wet mass greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalWetMass:
{
Description: Harvest data with total wet mass lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgWetMass:
{
Description: Harvest data with average wet mass greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgWetMass:
{
Description: Harvest data with average wet mass lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgMoisture:
{
Description: Harvest data with average moisture greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMoisture:
{
Description: Harvest data with average moisture lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgSpeed:
{
Description: Harvest data with average speed greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgSpeed:
{
Description: Harvest data with average speed lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Harvest data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Harvest operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Harvest operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Harvest operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Harvest operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Harvest operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Harvest operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Harvest operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Harvest operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of harvest operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of harvest operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Harvest data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_Get (new)
Description :  Get a specified harvest data resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/harvest-data/{harvestDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: Id of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_CreateOrUpdate (new)
Description :  Create or update harvest data resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/harvest-data/{harvestDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: IDd of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
harvestData:
{
Description: Harvest data resource payload to Create or update. ,
Required: False ,
}
{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
harvestProductDetails:
{
Description: Details of harvested products. ,
Required: False ,
}
[
{
productName:
{
Description: Name of a harvested product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgYield:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgWetMass:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the harvest data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the harvest operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the harvest operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (harvest). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the harvest operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the harvest operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
HarvestData_Delete (new)
Description :  Delete a specified harvest data resource for a given farmer.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/harvest-data/{harvestDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: Id of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_GetCascadeDeleteJobDetails (new)
Description :  Get details of a cascade delete job for harvest data resource.
Reference :  Link ¶

⚼ Request

GET:  /harvest-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the harvest data cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
HarvestData_CreateCascadeDeleteJob (new)
Description :  Create cascade delete job for harvest data resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /harvest-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the harvest data cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
harvestDataId:
{
Description: Id of the harvest data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
ImageProcessing_CreateRasterizeJob (new)
Description :  Create a job which converts shape files into raster images. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PUT:  /image-processing/rasterize/{jobId}
{
jobId:
{
Description: Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by the user. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Attachment id of the input shapefile which must be rasterized. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names that must be rasterized. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the image processing (rasterize) job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the image processing (rasterize) job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Attachment id of the input shapefile which must be rasterized. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names that must be rasterized. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the image processing (rasterize) job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the image processing (rasterize) job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{}
ImageProcessing_GetRasterizeJob (new)
Description :  Get details of rasterize job. Rasterize job converts shape files into raster images.
Reference :  Link ¶

⚼ Request

GET:  /image-processing/rasterize/{jobId}
{
jobId:
{
Description: Id of the image processing (rasterize) job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
shapefileAttachmentId:
{
Description: Attachment id of the input shapefile which must be rasterized. ,
Required: True ,
}
string ,
shapefileColumnNames:
{
Description: List of shapefile column names that must be rasterized. ,
Required: True ,
}
[
string ,
]
,
id:
{
Description: Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the image processing (rasterize) job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the image processing (rasterize) job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
OAuthProviders_List (new)
Description :  Get a paginated list of OAuth provider resources for a given search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers
{
ids:
{
Description: List of Ids of OAuth providers to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of OAuth providers to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: OAuth providers with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
appId:
{
Description: OAuth App Id for a given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for a given OAuth Provider. Note: The app secret will not be part of the response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for a given Provider. Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. ,
Required: False ,
}
string ,
isProductionApp:
{
Description: An optional flag to determine if the OAuth App is ready to be used for production scenarios. Note: This is applicable only for John Deere. ,
Required: False ,
}
boolean ,
id:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthProviders_Get (new)
Description :  Get a specified OAuth provider resource.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: Id of the OAuth provider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
appId:
{
Description: OAuth App Id for a given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for a given OAuth Provider. Note: The app secret will not be part of the response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for a given Provider. Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. ,
Required: False ,
}
string ,
isProductionApp:
{
Description: An optional flag to determine if the OAuth App is ready to be used for production scenarios. Note: This is applicable only for John Deere. ,
Required: False ,
}
boolean ,
id:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthProviders_CreateOrUpdate (new)
Description :  Create or update an OAuth provider resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: Id of the OAuth provider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
oauthProvider:
{
Description: OauthProvider resource payload to Create or update. ,
Required: False ,
}
{
appId:
{
Description: OAuth App Id for a given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for a given OAuth Provider. Note: The app secret will not be part of the response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for a given Provider. Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. ,
Required: False ,
}
string ,
isProductionApp:
{
Description: An optional flag to determine if the OAuth App is ready to be used for production scenarios. Note: This is applicable only for John Deere. ,
Required: False ,
}
boolean ,
id:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
appId:
{
Description: OAuth App Id for a given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for a given OAuth Provider. Note: The app secret will not be part of the response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for a given Provider. Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. ,
Required: False ,
}
string ,
isProductionApp:
{
Description: An optional flag to determine if the OAuth App is ready to be used for production scenarios. Note: This is applicable only for John Deere. ,
Required: False ,
}
boolean ,
id:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
appId:
{
Description: OAuth App Id for a given OAuth Provider. ,
Required: False ,
}
string ,
appSecret:
{
Description: OAuth App secret for a given OAuth Provider. Note: The app secret will not be part of the response. ,
Required: False ,
}
string ,
apiKey:
{
Description: OAuth Api key for a given Provider. Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. ,
Required: False ,
}
string ,
isProductionApp:
{
Description: An optional flag to determine if the OAuth App is ready to be used for production scenarios. Note: This is applicable only for John Deere. ,
Required: False ,
}
boolean ,
id:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthProviders_Delete (new)
Description :  Delete a specified OAuth provider resource.
Reference :  Link ¶

⚼ Request

DELETE:  /oauth/providers/{oauthProviderId}
{
oauthProviderId:
{
Description: Id of the OAuth provider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthProviders_GetCascadeDeleteJobDetails (new)
Description :  Get details of cascade delete job for an OAuth provider resource.
Reference :  Link ¶

⚼ Request

GET:  /oauth/providers/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the OAuth provider cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
oauthProviderId:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE'. ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the OAuth provider delete job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider cascade delete job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider cascade delete job.. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthProviders_CreateCascadeDeleteJob (new)
Description :  Create cascade delete job for an OAuth provider resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /oauth/providers/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the OAuth provider cascade delete job. ,
Required: True ,
}
string ,
oauthProviderId:
{
Description: Id of the OAuth provider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
oauthProviderId:
{
Description: FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE'. ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the OAuth provider delete job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the OAuth provider cascade delete job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the OAuth provider cascade delete job.. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthTokens_List (new)
Description :  Get a list of OAuthToken documents for a given search criteria.
Reference :  Link ¶

⚼ Request

GET:  /oauth/tokens
{
authProviderIds:
{
Description: List of Ids of OAuth providers to be returned. ,
Required: False ,
}
array ,
farmerIds:
{
Description: List of Ids of associated farmers. ,
Required: False ,
}
array ,
isValid:
{
Description: If set, only valid (non expired) OAuth tokens are returned. ,
Required: False ,
}
boolean ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the farmer for whom the OAuth flow is being configured. ,
Required: True ,
}
string ,
authProviderId:
{
Description: Id of the OAuth provider resource containing the app information. ,
Required: True ,
}
string ,
isValid:
{
Description: An optional flag indicating whether the token is valid or expired. ,
Required: False ,
}
boolean ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthTokens_GetCascadeDeleteJobDetails (new)
Description :  Get details of OAuth token remove job.
Reference :  Link ¶

⚼ Request

GET:  /oauth/tokens/remove/{jobId}
{
jobId:
{
Description: Id of the OAuth token removal job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
OAuthTokens_CreateCascadeDeleteJob (new)
Description :  Create job to remove OAuth token. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /oauth/tokens/remove/{jobId}
{
jobId:
{
Description: Id of the OAuth token removal job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
oauthProviderId:
{
Description: Id of the OAuth provider resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_ListByFarmerId (new)
Description :  Get a paginated list of planting data resources for a given farm and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/planting-data
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
minAvgPlantingRate:
{
Description: Planting data with average planting rate greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgPlantingRate:
{
Description: Planting data with average planting rate lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Planting data with total material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Planting data with total material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgMaterial:
{
Description: Planting data with average material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Planting data with total material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Planting data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Planting operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Planting operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Planting operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Planting operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Planting operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Planting operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Planting operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Planting operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of planting operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of planting operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Planting data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_List (new)
Description :  Get a paginated list of planting data resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /planting-data
{
minAvgPlantingRate:
{
Description: Planting data with average planting rate greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgPlantingRate:
{
Description: Planting data with average planting rate lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTotalMaterial:
{
Description: Planting data with total material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTotalMaterial:
{
Description: Planting data with total material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minAvgMaterial:
{
Description: Planting data with average material greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgMaterial:
{
Description: Planting data with average material lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Planting data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Planting operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Planting operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Planting operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Planting operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Planting operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Planting operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Planting operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Planting operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of planting operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of planting operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Planting data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_Get (new)
Description :  Get a specified planting data resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/planting-data/{plantingDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: Id of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_CreateOrUpdate (new)
Description :  Create or update a planting data resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/planting-data/{plantingDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: Id of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
plantingData:
{
Description: Planting data resource payload to Create or update. ,
Required: False ,
}
{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
avgPlantingRate:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
plantingProductDetails:
{
Description: Details of products planted. ,
Required: False ,
}
[
{
productName:
{
Description: Name of the planted product. ,
Required: False ,
}
string ,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
totalMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
avgMaterial:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the planting data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the planting operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the planting operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (planting). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the planting operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the planting operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
PlantingData_Delete (new)
Description :  Delete a specified planting data resource under a particular farmer.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/planting-data/{plantingDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: Id of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_GetCascadeDeleteJobDetails (new)
Description :  Get details of a cascade delete job for planting data resource.
Reference :  Link ¶

⚼ Request

GET:  /planting-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the planting data cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
PlantingData_CreateCascadeDeleteJob (new)
Description :  Create cascade delete job for planting data resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /planting-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the planting data cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
plantingDataId:
{
Description: Id of the planting data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Scenes_List (new)
Description :  Get a paginated list of scene resources for a given search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. 2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.
Reference :  Link ¶

⚼ Request

GET:  /scenes
{
provider:
{
Description: Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
source:
{
Description: Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation. ,
Required: False ,
}
string ,
startDateTime:
{
Description: Scenes that were captured/made available (at source) at or after this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Scenes that were captured/made available (at source) at or before this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCloudCoveragePercentage:
{
Description: Scenes with cloud cover less than or equal to the given value are returned. Range [0 to 100.0]. ,
Format: double ,
Required: False ,
}
number ,
maxDarkPixelCoveragePercentage:
{
Description: Scenes with dark pixel cover less than or equal to the given value are returned. Range [0 to 100.0]. ,
Format: double ,
Required: False ,
}
number ,
imageNames:
{
Description: List of names of images to be fetched. For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', 'dataMask', sunAzimuthAngles, sunZenithAngles, viewAzimuthMean and viewZenithMean. ,
Required: False ,
}
array ,
imageResolutions:
{
Description: List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. ,
Required: False ,
}
array ,
imageFormats:
{
Description: Format in which the scenes are to be returned. Available value: TIF. ,
Required: False ,
}
array ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
sceneDateTime:
{
Description: UTC Date-time at which the image was captured/made available at source (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
provider:
{
Description: Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider. ,
Required: False ,
}
string ,
source:
{
Description: Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation. ,
Required: False ,
}
string ,
imageFiles:
{
Description: Collection of image files. ,
Required: False ,
}
[
{
fileLink:
{
Description: Link to the image file. ,
Required: False ,
}
string ,
name:
{
Description: Name of the image file. ,
Required: True ,
}
string ,
imageFormat:
{
Description: Supported image formats for scene resource. ,
Enum:
{
TIF: No description available. ,
}
,
Required: False ,
}
enum ,
resolution:
{
Description: Resolution of image in meters. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
imageFormat:
{
Description: Supported image formats for scene resource. ,
Enum:
{
TIF: No description available. ,
}
,
Required: False ,
}
enum ,
cloudCoverPercentage:
{
Description: Signifies the percentage of the scene covered by clouds. ,
Format: double ,
Required: False ,
}
number ,
darkPixelPercentage:
{
Description: Signifies the percentage of the scene covered by dark pixels. ,
Format: double ,
Required: False ,
}
number ,
ndviMedianValue:
{
Description: Median of NDVI values of the scene. ,
Format: double ,
Required: False ,
}
number ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the scene ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Scenes_CreateSatelliteDataIngestionJob (new)
Description :  Create a satellite data ingestion job. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PUT:  /scenes/satellite/ingest-data/{jobId}
{
jobId:
{
Description: Id of the satellite data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by the user. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of names of images to be fetched. For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of formats in which images can be fetched. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
id:
{
Description: Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the satellite data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the satellite data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of names of images to be fetched. For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of formats in which images can be fetched. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
id:
{
Description: Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the satellite data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the satellite data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Scenes_GetSatelliteDataIngestionJobDetails (new)
Description :  Get details of a satellite data ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /scenes/satellite/ingest-data/{jobId}
{
jobId:
{
Description: Id of the satellite data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the boundary for which satellite data is being fetched. ,
Required: True ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
provider:
{
Description: Provider of satellite data. ,
Enum:
{
Microsoft: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of satellite data. ,
Enum:
{
Sentinel_2_L2A: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Data Model for SatelliteIngestionJobRequest. ,
Required: False ,
}
{
imageNames:
{
Description: List of names of images to be fetched. For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'. ,
Required: False ,
}
[
string ,
]
,
imageFormats:
{
Description: List of formats in which images can be fetched. Available value: TIF. ,
Required: False ,
}
[
string ,
]
,
imageResolutions:
{
Description: List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. ,
Required: False ,
}
[
number ,
]
,
}
,
id:
{
Description: Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the satellite data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the satellite data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Scenes_Download (new)
Description :  Return scenes as a file stream for a given input filePath.
Reference :  Link ¶

⚼ Request

GET:  /scenes/downloadFiles
{
filePath:
{
Description: Relative path where the scene is stored in cloud storage. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: binary ,
}
file ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_ListByFarmerId (new)
Description :  Get a paginated list of seasonal field resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/seasonal-fields
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
farmIds:
{
Description: Seasonal fields associated with the given farms are returned. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Seasonal fields associated with the given fields are returned. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Seasonal fields associated with the given seasons are returned. ,
Required: False ,
}
array ,
cropVarietyIds:
{
Description: Seasonal fields associated with at least one of the given crop varieties are returned. ,
Required: False ,
}
array ,
cropIds:
{
Description: Seasonal fields associated with at least one of the given crops are returned. ,
Required: False ,
}
array ,
minAvgYieldValue:
{
Description: Seasonal fields with average yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgYieldValue:
{
Description: Seasonal fields with average yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit of the average yield. ,
Required: False ,
}
string ,
minAvgSeedPopulationValue:
{
Description: Seasonal fields with average seed population greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgSeedPopulationValue:
{
Description: Seasonal fields with average seed population lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit of average seed population. ,
Required: False ,
}
string ,
minPlantingDateTime:
{
Description: Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxPlantingDateTime:
{
Description: Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
ids:
{
Description: List of Ids of seasonal fields to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of seasonal fields to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Seasonal fields with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_List (new)
Description :  Get a paginated list of seasonal field resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /seasonal-fields
{
farmIds:
{
Description: Seasonal fields associated with the given farms are returned. ,
Required: False ,
}
array ,
fieldIds:
{
Description: Seasonal fields associated with the given fields are returned. ,
Required: False ,
}
array ,
seasonIds:
{
Description: Seasonal fields associated with the given seasons are returned. ,
Required: False ,
}
array ,
cropVarietyIds:
{
Description: Seasonal fields associated with at least one of the given crop varieties are returned. ,
Required: False ,
}
array ,
cropIds:
{
Description: Seasonal fields associated with at least one of the given crops are returned. ,
Required: False ,
}
array ,
minAvgYieldValue:
{
Description: Seasonal fields with average yield greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgYieldValue:
{
Description: Seasonal fields with average yield lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit of the average yield. ,
Required: False ,
}
string ,
minAvgSeedPopulationValue:
{
Description: Seasonal fields with average seed population greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxAvgSeedPopulationValue:
{
Description: Seasonal fields with average seed population lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit of average seed population. ,
Required: False ,
}
string ,
minPlantingDateTime:
{
Description: Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxPlantingDateTime:
{
Description: Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
ids:
{
Description: List of Ids of seasonal fields to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of seasonal fields to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Seasonal fields with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_Get (new)
Description :  Get a specified seasonal field resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/seasonal-fields/{seasonalFieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_CreateOrUpdate (new)
Description :  Create or update a seasonal field resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/seasonal-fields/{seasonalFieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
seasonalField:
{
Description: Seasonal field resource payload to Create or update. ,
Required: False ,
}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
primaryBoundaryId:
{
Description: Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. ,
Required: False ,
}
string ,
boundaryIds:
{
Description: List of Ids of boundaries associated with the seasonal field. ,
Required: False ,
}
[
string ,
]
,
farmId:
{
Description: Id of the associated farm. ,
Required: False ,
}
string ,
fieldId:
{
Description: Id of the associated field. ,
Required: False ,
}
string ,
seasonId:
{
Description: Id of the season associated with the seasonal field. ,
Required: False ,
}
string ,
cropVarietyIds:
{
Description: List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. ,
Required: False ,
}
[
string ,
]
,
cropId:
{
Description: Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. ,
Required: False ,
}
string ,
avgYieldValue:
{
Description: Average yield generated from the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgYieldUnit:
{
Description: Unit to measure average yield. ,
Required: False ,
}
string ,
avgSeedPopulationValue:
{
Description: Average seed population planted in the seasonal field. ,
Format: double ,
Required: False ,
}
number ,
avgSeedPopulationUnit:
{
Description: Unit to measure average seed population. ,
Required: False ,
}
string ,
plantingDateTime:
{
Description: UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the seasonal field. This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the seasonal field. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the seasonal field. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_Delete (new)
Description :  Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/seasonal-fields/{seasonalFieldId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_GetCascadeDeleteJobDetails (new)
Description :  Get details of cascade delete job for a specified seasonal field.
Reference :  Link ¶

⚼ Request

GET:  /seasonal-fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the seasonal field cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
SeasonalFields_CreateCascadeDeleteJob (new)
Description :  Create a cascade delete job for a specified seasonal field. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /seasonal-fields/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the seasonal field cascade delete job. This Id is unique for a given tenant. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
seasonalFieldId:
{
Description: Id of the seasonal field to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Seasons_List (new)
Description :  Get a paginated list of season resources. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /seasons
{
minStartDateTime:
{
Description: Seasons which start at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxStartDateTime:
{
Description: Seasons which start at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minEndDateTime:
{
Description: Seasons which end at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxEndDateTime:
{
Description: Seasons which end at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
years:
{
Description: Seasons with given list of years are returned. ,
Required: False ,
}
array ,
ids:
{
Description: List of Ids of seasons to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of seasons to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Seasons with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
startDateTime:
{
Description: UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Year associated with the harvest i.e. year of season end date-time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Unique Id of the season. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the season. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the season. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Seasons_Get (new)
Description :  Get a specified season resource.
Reference :  Link ¶

⚼ Request

GET:  /seasons/{seasonId}
{
seasonId:
{
Description: Id of the season. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
startDateTime:
{
Description: UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Year associated with the harvest i.e. year of season end date-time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Unique Id of the season. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the season. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the season. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Seasons_CreateOrUpdate (new)
Description :  Create or update a season resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /seasons/{seasonId}
{
seasonId:
{
Description: Unique Id of the season. This Id is unique for a given tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
season:
{
Description: Season resource payload to Create or update. ,
Required: False ,
}
{
startDateTime:
{
Description: UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Year associated with the harvest i.e. year of season end date-time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Unique Id of the season. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the season. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the season. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
startDateTime:
{
Description: UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Year associated with the harvest i.e. year of season end date-time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Unique Id of the season. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the season. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the season. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (200)

{
startDateTime:
{
Description: UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
year:
{
Description: Year associated with the harvest i.e. year of season end date-time. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Unique Id of the season. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the season. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the season. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Seasons_Delete (new)
Description :  Delete a specified season resource.
Reference :  Link ¶

⚼ Request

DELETE:  /seasons/{seasonId}
{
seasonId:
{
Description: Id of the season. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_ListByFarmerId (new)
Description :  Get a paginated list of tillage data resources for a given farmer and search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/tillage-data
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
minTillageDepth:
{
Description: Tillage data with tillage depth greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTillageDepth:
{
Description: Tillage data with tillage depth lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTillagePressure:
{
Description: Tillage data with tillage pressure greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTillagePressure:
{
Description: Tillage data with tillage pressure lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Tillage data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Tillage operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Tillage operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Tillage operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Tillage operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Tillage operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Tillage operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Tillage operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Tillage operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of tillage operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of tillage operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Tillage data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_List (new)
Description :  Get a paginated list of tillage data resources across all the farmers for a given search criteria. ###### Note: 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.
Reference :  Link ¶

⚼ Request

GET:  /tillage-data
{
minTillageDepth:
{
Description: Tillage data with tillage depth greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTillageDepth:
{
Description: Tillage data with tillage depth lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
minTillagePressure:
{
Description: Tillage data with tillage pressure greater than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
maxTillagePressure:
{
Description: Tillage data with tillage pressure lesser than or equal to the value specified will be returned. ,
Format: double ,
Required: False ,
}
number ,
sources:
{
Description: Tillage data obtained from the given list of sources will be returned. ,
Required: False ,
}
array ,
associatedBoundaryIds:
{
Description: List of boundary Ids of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
array ,
operationBoundaryIds:
{
Description: List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
array ,
minOperationStartDateTime:
{
Description: Tillage operations that began at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationStartDateTime:
{
Description: Tillage operations that began at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationEndDateTime:
{
Description: Tillage operations that ended at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationEndDateTime:
{
Description: Tillage operations that ended at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minOperationModifiedDateTime:
{
Description: Tillage operations that were modified (at source) at or after the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
maxOperationModifiedDateTime:
{
Description: Tillage operations that were modified (at source) at or before the given UTC date-time is returned. ,
Format: date-time ,
Required: False ,
}
string ,
minArea:
{
Description: Tillage operations carried over area greater than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
maxArea:
{
Description: Tillage operations carried over area lesser than or equal to the given value is returned. ,
Format: double ,
Required: False ,
}
number ,
ids:
{
Description: List of Ids of tillage operations to be returned. ,
Required: False ,
}
array ,
names:
{
Description: List of names of tillage operations to be returned. ,
Required: False ,
}
array ,
propertyFilters:
{
Description: Filters on key-value pairs within 'Properties'. eg. "{testKey} eq {testValue}". ,
Required: False ,
}
array ,
statuses:
{
Description: Tillage data with only the given statuses are returned. ,
Required: False ,
}
array ,
minCreatedDateTime:
{
Description: Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxCreatedDateTime:
{
Description: Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
minLastModifiedDateTime:
{
Description: Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
maxLastModifiedDateTime:
{
Description: Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_Get (new)
Description :  Get a specified tillage data resource for a given farmer.
Reference :  Link ¶

⚼ Request

GET:  /farmers/{farmerId}/tillage-data/{tillageDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: Id of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_CreateOrUpdate (new)
Description :  Create or update a tillage data resource for a given farmer. ###### Note: 1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PATCH:  /farmers/{farmerId}/tillage-data/{tillageDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: Id of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
tillageData:
{
Description: Tillage data resource payload to Create or update. ,
Required: False ,
}
{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
tillageDepth:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
tillagePressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
area:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
source:
{
Description: Represents the source from which the tillage data was obtained. ,
Required: False ,
}
string ,
operationModifiedDateTime:
{
Description: UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. ,
Format: date-time ,
Required: False ,
}
string ,
operationStartDateTime:
{
Description: UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
operationEndDateTime:
{
Description: UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
attachmentsLink:
{
Description: Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. ,
Required: False ,
}
string ,
associatedBoundaryId:
{
Description: Id of the boundary of the field/seasonal field on which the tillage operation was done. ,
Required: False ,
}
string ,
operationBoundaryId:
{
Description: Id of the boundary that is created using the geographical area on which the tillage operation was carried out. ,
Required: False ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the operation (tillage). This Id is unique for a given farmer. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
status:
{
Description: User determined status of the resource. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the tillage operation. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the tillage operation. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
TillageData_Delete (new)
Description :  Delete a specified tillage data resource for a given farmer.
Reference :  Link ¶

⚼ Request

DELETE:  /farmers/{farmerId}/tillage-data/{tillageDataId}
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: Id of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_GetCascadeDeleteJobDetails (new)
Description :  Get details of a cascade delete job for tillage data resource.
Reference :  Link ¶

⚼ Request

GET:  /tillage-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the tillage data cascade delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
TillageData_CreateCascadeDeleteJob (new)
Description :  Create cascade delete job for tillage data resource. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.
Reference :  Link ¶

⚼ Request

PUT:  /tillage-data/cascade-delete/{jobId}
{
jobId:
{
Description: Id of the tillage data cascade delete job. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
tillageDataId:
{
Description: Id of the tillage data resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
farmerId:
{
Description: Farmer Id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The id of the resource which is to be deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
resourceType:
{
Description: Signifies the type of the resource that is being deleted (along with the subtree & associated data). ,
Required: True ,
}
string ,
id:
{
Description: Unique Id of the cascade delete job. This Id is unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Enum:
{
Waiting: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Weather_List (new)
Description :  Get a paginated list of weather data resources for a given search criteria. ###### Note: 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. 2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.
Reference :  Link ¶

⚼ Request

GET:  /weather
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: True ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: True ,
}
string ,
startDateTime:
{
Description: Weather data at or after the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Weather data at or before the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
$maxPageSize:
{
Description: Maximum number of items to be returned in a single page. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Skip token for getting next set of results. ,
Required: False ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of requested objects. ,
Required: False ,
}
[
{
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
location:
{
Description: Location model class. ,
Required: True ,
}
{
latitude:
{
Description: Latitude of the location. ,
Format: double ,
Required: True ,
}
number ,
longitude:
{
Description: Longitude of the location. ,
Format: double ,
Required: True ,
}
number ,
}
,
dateTime:
{
Description: UTC Date-time of the weather data (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: True ,
}
string ,
unitSystemCode:
{
Description: Unit system like US/SI etc. ,
Required: False ,
}
string ,
extensionVersion:
{
Description: Version of the weather data extension. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: True ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: True ,
}
string ,
cloudCover:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
dewPoint:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
growingDegreeDay:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
precipitation:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
pressure:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
relativeHumidity:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
soilMoisture:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
soilTemperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
temperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
visibility:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
wetBulbTemperature:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windChill:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windDirection:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windGust:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
windSpeed:
{
Description: Schema for storing measurement reading and unit. ,
Required: False ,
}
{
unit:
{
Description: Data unit. ,
Required: False ,
}
string ,
value:
{
Description: Data value. ,
Format: double ,
Required: False ,
}
number ,
}
,
id:
{
Description: Unique id of weather data. ,
Required: False ,
}
string ,
eTag:
{
Description: ETag value can be used to implement optimistic concurrency. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
modifiedDateTime:
{
Description: UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
]
,
$skipToken:
{
Description: Token used in retrieving the next page. If null, there are no additional pages. ,
Required: False ,
}
string ,
nextLink:
{
Description: Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Weather_GetDataIngestionJobDetails (new)
Description :  Get details of a weather data ingestion job.
Reference :  Link ¶

⚼ Request

GET:  /weather/ingest-data/{jobId}
{
jobId:
{
Description: Id of the weather data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which the request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to weather data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Weather_CreateDataIngestionJob (new)
Description :  Create a weather data ingestion job. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PUT:  /weather/ingest-data/{jobId}
{
jobId:
{
Description: Id of the weather data ingestion job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by the user. ,
Required: False ,
}
{
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which the request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to weather data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
boundaryId:
{
Description: Id of the associated boundary. ,
Required: True ,
}
string ,
farmerId:
{
Description: Id of the associated farmer. ,
Required: True ,
}
string ,
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
extensionApiName:
{
Description: Extension api name to which the request is to be made. ,
Required: True ,
}
string ,
extensionApiInput:
{
Description: Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider. ,
Required: True ,
}
object ,
extensionDataProviderAppId:
{
Description: App id of the weather data provider. ,
Required: False ,
}
string ,
extensionDataProviderApiKey:
{
Description: Api key of the weather data provider. ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data ingestion job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name to weather data ingestion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data ingestion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Weather_GetDataDeleteJobDetails (new)
Description :  Get details of a weather data delete job.
Reference :  Link ¶

⚼ Request

GET:  /weather/delete-data/{jobId}
{
jobId:
{
Description: Id of the weather data delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
farmerId:
{
Description: The Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the associated boundary. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: False ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data delete job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the weather data deletion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data deletion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}
Weather_CreateDataDeleteJob (new)
Description :  Create a weather data delete job. ###### Note: 1. The **‘contentType’** in the request header should be **'application/json'**. 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.
Reference :  Link ¶

⚼ Request

PUT:  /weather/delete-data/{jobId}
{
jobId:
{
Description: Id of the weather data delete job. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested API version. ,
Required: True ,
}
string ,
job:
{
Description: Job parameters supplied by the user. ,
Required: False ,
}
{
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
farmerId:
{
Description: The Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the associated boundary. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: False ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data delete job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the weather data deletion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data deletion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
extensionId:
{
Description: Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg). ,
Required: True ,
}
string ,
farmerId:
{
Description: The Id of the associated farmer. ,
Required: True ,
}
string ,
boundaryId:
{
Description: The id of the associated boundary. ,
Required: True ,
}
string ,
weatherDataType:
{
Description: Type of weather data (forecast/historical). ,
Required: False ,
}
string ,
granularity:
{
Description: Granularity of weather data (daily/hourly). ,
Required: False ,
}
string ,
startDateTime:
{
Description: UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Unique Id of the weather data delete job. This Id must be unique for a given tenant. ,
Required: False ,
}
string ,
status:
{
Description: Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. ,
Format: double ,
Required: False ,
}
number ,
message:
{
Description: Brief description of the result of the job. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Name of the weather data deletion job. ,
Required: False ,
}
string ,
description:
{
Description: Brief description of the weather data deletion job. ,
Required: False ,
}
string ,
properties:
{
Description: A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error from Azure FarmBeats service. ,
Required: False ,
}
{
code:
{
Description: Server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: Target of the error. ,
Required: False ,
}
string ,
details:
{
Description: Array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: Inner error containing list of errors. InnerError reference document. ,
Required: False ,
}
{
code:
{
Description: Specific error code than was provided by the containing error. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
traceId:
{
Description: Unique trace Id. ,
Required: False ,
}
string ,
}